home *** CD-ROM | disk | FTP | other *** search
/ Risc World 5 / Risc World 5.iso / SOFTWARE / Issue3 / FAMILY / Calendar / README < prev   
Encoding:
Text File  |  2003-09-23  |  3.3 KB  |  87 lines
  1. README for Calendar v0.10
  2. =========================
  3.  
  4. *** IMPORTANT CHANGE ***
  5.  
  6. Since v0.02, the module was changed to use the Julian Day number for
  7. internal representation of dates instead of the Gregorian Day number.
  8.  
  9. The names of the SWIs have changed also. The 'GDay' part now reads 'JDay'.
  10.  
  11. Note that this makes v0.01 and v0.02 incompatible with v0.10. Software
  12. written for use with the earlier versions needs to be adapted to the new
  13. names.
  14.  
  15. If your program has stored the Gregorian Day numbers somewhere, you will
  16. need to convert them to Julian Day numbers. The formula is:
  17.  
  18. JDay = GDay + 1721425
  19.  
  20. *** ***
  21.  
  22. This version only supports Julian (1) and Gregorian (2) calendars.
  23. It only supports Calendar_JDayToDate and Calendar_DateToJDay.
  24.  
  25. The package contains:
  26.         !Contents - A file listing all the files in the package. Used by !Filer.
  27.  
  28.         !System  - a directory structure containing the module, ready to be
  29.                    merged with your !System
  30.  
  31.         Calendar - another copy of the module
  32.  
  33.         README   - this readme file
  34.  
  35.         CalLib   - a library of C veneers for the SWIs
  36.         CalLib.SetVars    - Sets CalLib$Path so you can use
  37.                             #include "CalLib:calendar.h"
  38.         CalLib.o.calendar - the library
  39.         CalLib.h.calendar - a header file describing the routines
  40.         CalLib.s.calendar - the assembler source used to make the routines,
  41.                             for your information
  42.  
  43.         Demo.!Datum  - A little demo written in C, using the CalLib veneers,
  44.                        complete with sources.
  45.  
  46.         Demo.BASIC   - a directory with some test and demo programs written
  47.                        in BASIC
  48.         Demo.BASIC.Test1 - Convert to GDay and back. Show registers
  49.         Demo.BASIC.Test2 - Compare between Gregorian and Julian calendar for a
  50.                            sequence of dates
  51.         Demo.BASIC.Test3 - For a given date, calculate the date that is N days
  52.                            away
  53.         Demo.BASIC.Test4 - Try to trigger an error
  54.         Demo.BASIC.Test5 - Calculate the difference between two dates
  55.  
  56.         Docs     - a directory with documentation, containing:
  57.         Docs.History - a cumulative list of changes from version to version
  58.         Docs.ManHTML - a HTML version of the manual
  59.         Docs.ManText - a text version of the manual
  60.  
  61. Note: the source file for the manual, which is written in EasyWriter, is no
  62. longer supplied. HTML and text version have been extracted from the source.
  63.  
  64. To install, merge the !System directory in this package with your !System
  65. directory using the Sysmerge facility. (On recent versions of RISC OS:
  66. double-click !Boot, select System and follow the instructions.) You can then
  67. load the module with something like
  68.  
  69. *RMEnsure Calendar 0 RMLoad System:Modules.Calendar
  70.  
  71. Alternatimvely, you can put the module inside your own application's directory
  72. (!Myapp.Calendar or similar) and load it from there:
  73.  
  74. *RMEnsure Calendar 0 RMLoad <MyApp$Dir>.Calendar
  75.  
  76. To see direct results (e.g. for running the test programs) simply double-click
  77. the Calendar file.
  78.  
  79.  
  80. The SWIs are described in the manual. Note the limitations mentioned in this
  81. README.
  82.  
  83. This package is FREEWARE. It may be copied freely, provided no part of it is
  84. changed and that it is not sold for profit.
  85.  
  86. $Id: README 1.3 2003-09-23 04:03:31+01 erikgrnh Exp erikgrnh $
  87.